Node / ReticulumProjects / Reticulum_CE.git / files / RNS / Interfaces / PipeInterface.py

Displaying Raw • Download

T8b949e# Reticulum License

T8b949e#

T8b949e# Copyright (c) 2016-2025 Mark Qvist

T8b949e#

T8b949e# Permission is hereby granted, free of charge, to any person obtaining a copy

T8b949e# of this software and associated documentation files (the "Software"), to deal

T8b949e# in the Software without restriction, including without limitation the rights

T8b949e# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

T8b949e# copies of the Software, and to permit persons to whom the Software is

T8b949e# furnished to do so, subject to the following conditions:

T8b949e#

T8b949e# - The Software shall not be used in any kind of system which includes amongst

T8b949e# its functions the ability to purposefully do harm to human beings.

T8b949e#

T8b949e# - The Software shall not be used, directly or indirectly, in the creation of

T8b949e# an artificial intelligence, machine learning or language model training

T8b949e# dataset, including but not limited to any use that contributes to the

T8b949e# training or development of such a model or algorithm.

T8b949e#

T8b949e# - The above copyright notice and this permission notice shall be included in

T8b949e# all copies or substantial portions of the Software.

T8b949e#

T8b949e# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

T8b949e# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

T8b949e# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

T8b949e# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

T8b949e# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

T8b949e# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

T8b949e# SOFTWARE.

Tff7b72from T7ee787RNST7ee787.T7ee787InterfacesT7ee787.T7ee787Interface Tff7b72import Te6edf3Interface

Tff7b72from T7ee787time Tff7b72import Te6edf3sleep

Tff7b72import T7ee787sys

Tff7b72import T7ee787threading

Tff7b72import T7ee787time

Tff7b72import T7ee787RNS

Tff7b72import T7ee787subprocess

Tff7b72import T7ee787shlex

Tff7b72class T56d364HDLCTb4b4b4(Tb4b4b4)Tb4b4b4:

T8b949e# The Pipe Interface packetizes data using

T8b949e# simplified HDLC framing, similar to PPP

Te6edf3FLAG Tff7b72= T79c0ff0x7E

Te6edf3ESC Tff7b72= T79c0ff0x7D

Te6edf3ESC_MASK Tff7b72= T79c0ff0x20

Tf0883e@staticmethod

Tff7b72def Td2a8ffescapeTb4b4b4(Te6edf3dataTb4b4b4)Tb4b4b4:

Te6edf3data Tff7b72= Te6edf3dataTff7b72.Td2a8ffreplaceTb4b4b4(Tffa657bytesTb4b4b4(Tb4b4b4[Te6edf3HDLCTff7b72.Td2a8ffESCTb4b4b4]Tb4b4b4)Tb4b4b4, Tffa657bytesTb4b4b4(Tb4b4b4[Te6edf3HDLCTff7b72.Td2a8ffESCTb4b4b4, Te6edf3HDLCTff7b72.Td2a8ffESCTff7b72^Te6edf3HDLCTff7b72.Td2a8ffESC_MASKTb4b4b4]Tb4b4b4)Tb4b4b4)

Te6edf3data Tff7b72= Te6edf3dataTff7b72.Td2a8ffreplaceTb4b4b4(Tffa657bytesTb4b4b4(Tb4b4b4[Te6edf3HDLCTff7b72.Td2a8ffFLAGTb4b4b4]Tb4b4b4)Tb4b4b4, Tffa657bytesTb4b4b4(Tb4b4b4[Te6edf3HDLCTff7b72.Td2a8ffESCTb4b4b4, Te6edf3HDLCTff7b72.Td2a8ffFLAGTff7b72^Te6edf3HDLCTff7b72.Td2a8ffESC_MASKTb4b4b4]Tb4b4b4)Tb4b4b4)

Tff7b72return Te6edf3data

Tff7b72class T56d364PipeInterfaceTb4b4b4(Te6edf3InterfaceTb4b4b4)Tb4b4b4:

Te6edf3MAX_CHUNK Tff7b72= T79c0ff32768

Te6edf3BITRATE_GUESS Tff7b72= T79c0ff1Tff7b72*T79c0ff1000Tff7b72*T79c0ff1000

Te6edf3DEFAULT_IFAC_SIZE Tff7b72= T79c0ff8

Te6edf3owner Tff7b72= Tff7b72None

Te6edf3command Tff7b72= Tff7b72None

Tff7b72def Tff7b72__init__Tb4b4b4(Tff7b72selfTb4b4b4, Te6edf3ownerTb4b4b4, Te6edf3configurationTb4b4b4)Tb4b4b4:

Tffa657superTb4b4b4(Tb4b4b4)Tff7b72.Td2a8ff__init__Tb4b4b4(Tb4b4b4)

Te6edf3c Tff7b72= Te6edf3InterfaceTff7b72.Td2a8ffget_config_objTb4b4b4(Te6edf3configurationTb4b4b4)

Te6edf3name Tff7b72= Te6edf3cTb4b4b4[Ta5d6ff"Ta5d6ffnameTa5d6ff"Tb4b4b4]

Te6edf3command Tff7b72= Te6edf3cTb4b4b4[Ta5d6ff"Ta5d6ffcommandTa5d6ff"Tb4b4b4] Tff7b72if Ta5d6ff"Ta5d6ffcommandTa5d6ff" Tff7b72in Te6edf3c Tff7b72else Tff7b72None

Te6edf3respawn_delay Tff7b72= Te6edf3cTff7b72.Td2a8ffas_floatTb4b4b4(Ta5d6ff"Ta5d6ffrespawn_delayTa5d6ff"Tb4b4b4) Tff7b72if Ta5d6ff"Ta5d6ffrespawn_delayTa5d6ff" Tff7b72in Te6edf3c Tff7b72else Tff7b72None

Tff7b72if Te6edf3command Tff7b72== Tff7b72NoneTb4b4b4:

Tff7b72raise Tf85149ValueErrorTb4b4b4(Ta5d6ff"Ta5d6ffNo command specified for PipeInterfaceTa5d6ff"Tb4b4b4)

Tff7b72if Te6edf3respawn_delay Tff7b72== Tff7b72NoneTb4b4b4:

Te6edf3respawn_delay Tff7b72= T79c0ff5

Tff7b72selfTff7b72.Td2a8ffHW_MTU Tff7b72= T79c0ff1064

Tff7b72selfTff7b72.Td2a8ffowner Tff7b72= Te6edf3owner

Tff7b72selfTff7b72.Td2a8ffname Tff7b72= Te6edf3name

Tff7b72selfTff7b72.Td2a8ffcommand Tff7b72= Te6edf3command

Tff7b72selfTff7b72.Td2a8ffprocess Tff7b72= Tff7b72None

Tff7b72selfTff7b72.Td2a8fftimeout Tff7b72= T79c0ff100

Tff7b72selfTff7b72.Td2a8ffonline Tff7b72= Tff7b72False

Tff7b72selfTff7b72.Td2a8ffpipe_is_open Tff7b72= Tff7b72False

Tff7b72selfTff7b72.Td2a8ffbitrate Tff7b72= Te6edf3PipeInterfaceTff7b72.Td2a8ffBITRATE_GUESS

Tff7b72selfTff7b72.Td2a8ffrespawn_delay Tff7b72= Te6edf3respawn_delay

Tff7b72tryTb4b4b4:

Tff7b72selfTff7b72.Td2a8ffopen_pipeTb4b4b4(Tb4b4b4)

Tff7b72except Tf85149Exception Tff7b72as Te6edf3eTb4b4b4:

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffCould connect pipe for interface Ta5d6ff"Tff7b72+Tffa657strTb4b4b4(Tff7b72selfTb4b4b4)Tb4b4b4, Te6edf3RNSTff7b72.Td2a8ffLOG_ERRORTb4b4b4)

Tff7b72raise Te6edf3e

Tff7b72if Tff7b72selfTff7b72.Td2a8ffpipe_is_openTb4b4b4:

Tff7b72selfTff7b72.Td2a8ffconfigure_pipeTb4b4b4(Tb4b4b4)

Tff7b72elseTb4b4b4:

Tff7b72raise Tf85149IOErrorTb4b4b4(Ta5d6ff"Ta5d6ffCould not connect pipeTa5d6ff"Tb4b4b4)

Tff7b72def Td2a8ffopen_pipeTb4b4b4(Tff7b72selfTb4b4b4)Tb4b4b4:

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffConnecting subprocess pipe for Ta5d6ff"Tff7b72+Tffa657strTb4b4b4(Tff7b72selfTb4b4b4)Tff7b72+Ta5d6ff"Ta5d6ff...Ta5d6ff"Tb4b4b4, Te6edf3RNSTff7b72.Td2a8ffLOG_VERBOSETb4b4b4)

Tff7b72tryTb4b4b4:

Tff7b72selfTff7b72.Td2a8ffprocess Tff7b72= Te6edf3subprocessTff7b72.Td2a8ffPopenTb4b4b4(Te6edf3shlexTff7b72.Td2a8ffsplitTb4b4b4(Tff7b72selfTff7b72.Td2a8ffcommandTb4b4b4)Tb4b4b4, Te6edf3stdinTff7b72=Te6edf3subprocessTff7b72.Td2a8ffPIPETb4b4b4, Te6edf3stdoutTff7b72=Te6edf3subprocessTff7b72.Td2a8ffPIPETb4b4b4)

Tff7b72selfTff7b72.Td2a8ffpipe_is_open Tff7b72= Tff7b72True

Tff7b72except Tf85149Exception Tff7b72as Te6edf3eTb4b4b4:

Tff7b72raise Te6edf3e

Tff7b72selfTff7b72.Td2a8ffpipe_is_open Tff7b72= Tff7b72False

Tff7b72def Td2a8ffconfigure_pipeTb4b4b4(Tff7b72selfTb4b4b4)Tb4b4b4:

Te6edf3sleepTb4b4b4(T79c0ff0.01Tb4b4b4)

Te6edf3thread Tff7b72= Te6edf3threadingTff7b72.Td2a8ffThreadTb4b4b4(Te6edf3targetTff7b72=Tff7b72selfTff7b72.Td2a8ffreadLoopTb4b4b4)

Te6edf3threadTff7b72.Td2a8ffdaemon Tff7b72= Tff7b72True

Te6edf3threadTff7b72.Td2a8ffstartTb4b4b4(Tb4b4b4)

Tff7b72selfTff7b72.Td2a8ffonline Tff7b72= Tff7b72True

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffSubprocess pipe for Ta5d6ff"Tff7b72+Tffa657strTb4b4b4(Tff7b72selfTb4b4b4)Tff7b72+Ta5d6ff"Ta5d6ff is now connectedTa5d6ff"Tb4b4b4, Te6edf3RNSTff7b72.Td2a8ffLOG_VERBOSETb4b4b4)

Tff7b72def Td2a8ffprocess_incomingTb4b4b4(Tff7b72selfTb4b4b4, Te6edf3dataTb4b4b4)Tb4b4b4:

Tff7b72selfTff7b72.Td2a8ffrxb Tff7b72+Tff7b72= Tffa657lenTb4b4b4(Te6edf3dataTb4b4b4)

Tff7b72selfTff7b72.Td2a8ffownerTff7b72.Td2a8ffinboundTb4b4b4(Te6edf3dataTb4b4b4, Tff7b72selfTb4b4b4)

Tff7b72def Td2a8ffprocess_outgoingTb4b4b4(Tff7b72selfTb4b4b4,Te6edf3dataTb4b4b4)Tb4b4b4:

Tff7b72if Tff7b72selfTff7b72.Td2a8ffonlineTb4b4b4:

Te6edf3data Tff7b72= Tffa657bytesTb4b4b4(Tb4b4b4[Te6edf3HDLCTff7b72.Td2a8ffFLAGTb4b4b4]Tb4b4b4)Tff7b72+Te6edf3HDLCTff7b72.Td2a8ffescapeTb4b4b4(Te6edf3dataTb4b4b4)Tff7b72+Tffa657bytesTb4b4b4(Tb4b4b4[Te6edf3HDLCTff7b72.Td2a8ffFLAGTb4b4b4]Tb4b4b4)

Te6edf3written Tff7b72= Tff7b72selfTff7b72.Td2a8ffprocessTff7b72.Td2a8ffstdinTff7b72.Td2a8ffwriteTb4b4b4(Te6edf3dataTb4b4b4)

Tff7b72selfTff7b72.Td2a8ffprocessTff7b72.Td2a8ffstdinTff7b72.Td2a8ffflushTb4b4b4(Tb4b4b4)

Tff7b72selfTff7b72.Td2a8fftxb Tff7b72+Tff7b72= Tffa657lenTb4b4b4(Te6edf3dataTb4b4b4)

Tff7b72if Te6edf3written Tff7b72!= Tffa657lenTb4b4b4(Te6edf3dataTb4b4b4)Tb4b4b4:

Tff7b72raise Tf85149IOErrorTb4b4b4(Ta5d6ff"Ta5d6ffPipe interface only wrote Ta5d6ff"Tff7b72+Tffa657strTb4b4b4(Te6edf3writtenTb4b4b4)Tff7b72+Ta5d6ff"Ta5d6ff bytes of Ta5d6ff"Tff7b72+Tffa657strTb4b4b4(Tffa657lenTb4b4b4(Te6edf3dataTb4b4b4)Tb4b4b4)Tb4b4b4)

Tff7b72def Td2a8ffreadLoopTb4b4b4(Tff7b72selfTb4b4b4)Tb4b4b4:

Tff7b72tryTb4b4b4:

Te6edf3in_frame Tff7b72= Tff7b72False

Te6edf3escape Tff7b72= Tff7b72False

Te6edf3data_buffer Tff7b72= Ta5d6ffbTa5d6ff"Ta5d6ff"

Te6edf3last_read_ms Tff7b72= Tffa657intTb4b4b4(Te6edf3timeTff7b72.Td2a8fftimeTb4b4b4(Tb4b4b4)Tff7b72*T79c0ff1000Tb4b4b4)

Tff7b72while Tff7b72TrueTb4b4b4:

Te6edf3process_output Tff7b72= Tff7b72selfTff7b72.Td2a8ffprocessTff7b72.Td2a8ffstdoutTff7b72.Td2a8ffreadTb4b4b4(T79c0ff1Tb4b4b4)

Tff7b72if Tffa657lenTb4b4b4(Te6edf3process_outputTb4b4b4) Tff7b72== T79c0ff0 Tff7b72and Tff7b72selfTff7b72.Td2a8ffprocessTff7b72.Td2a8ffpollTb4b4b4(Tb4b4b4) Tff7b72is Tff7b72not Tff7b72NoneTb4b4b4:

Tff7b72break

Tff7b72elseTb4b4b4:

Te6edf3byte Tff7b72= Tffa657ordTb4b4b4(Te6edf3process_outputTb4b4b4)

Te6edf3last_read_ms Tff7b72= Tffa657intTb4b4b4(Te6edf3timeTff7b72.Td2a8fftimeTb4b4b4(Tb4b4b4)Tff7b72*T79c0ff1000Tb4b4b4)

Tff7b72if Tb4b4b4(Te6edf3in_frame Tff7b72and Te6edf3byte Tff7b72== Te6edf3HDLCTff7b72.Td2a8ffFLAGTb4b4b4)Tb4b4b4:

Te6edf3in_frame Tff7b72= Tff7b72False

Tff7b72selfTff7b72.Td2a8ffprocess_incomingTb4b4b4(Te6edf3data_bufferTb4b4b4)

Tff7b72elif Tb4b4b4(Te6edf3byte Tff7b72== Te6edf3HDLCTff7b72.Td2a8ffFLAGTb4b4b4)Tb4b4b4:

Te6edf3in_frame Tff7b72= Tff7b72True

Te6edf3data_buffer Tff7b72= Ta5d6ffbTa5d6ff"Ta5d6ff"

Tff7b72elif Tb4b4b4(Te6edf3in_frame Tff7b72and Tffa657lenTb4b4b4(Te6edf3data_bufferTb4b4b4) Tff7b72< Tff7b72selfTff7b72.Td2a8ffHW_MTUTb4b4b4)Tb4b4b4:

Tff7b72if Tb4b4b4(Te6edf3byte Tff7b72== Te6edf3HDLCTff7b72.Td2a8ffESCTb4b4b4)Tb4b4b4:

Te6edf3escape Tff7b72= Tff7b72True

Tff7b72elseTb4b4b4:

Tff7b72if Tb4b4b4(Te6edf3escapeTb4b4b4)Tb4b4b4:

Tff7b72if Tb4b4b4(Te6edf3byte Tff7b72== Te6edf3HDLCTff7b72.Td2a8ffFLAG Tff7b72^ Te6edf3HDLCTff7b72.Td2a8ffESC_MASKTb4b4b4)Tb4b4b4:

Te6edf3byte Tff7b72= Te6edf3HDLCTff7b72.Td2a8ffFLAG

Tff7b72if Tb4b4b4(Te6edf3byte Tff7b72== Te6edf3HDLCTff7b72.Td2a8ffESC Tff7b72^ Te6edf3HDLCTff7b72.Td2a8ffESC_MASKTb4b4b4)Tb4b4b4:

Te6edf3byte Tff7b72= Te6edf3HDLCTff7b72.Td2a8ffESC

Te6edf3escape Tff7b72= Tff7b72False

Te6edf3data_buffer Tff7b72= Te6edf3data_bufferTff7b72+Tffa657bytesTb4b4b4(Tb4b4b4[Te6edf3byteTb4b4b4]Tb4b4b4)

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffSubprocess terminated on Ta5d6ff"Tff7b72+Tffa657strTb4b4b4(Tff7b72selfTb4b4b4)Tb4b4b4)

Tff7b72selfTff7b72.Td2a8ffprocessTff7b72.Td2a8ffkillTb4b4b4(Tb4b4b4)

Tff7b72except Tf85149Exception Tff7b72as Te6edf3eTb4b4b4:

Tff7b72selfTff7b72.Td2a8ffonline Tff7b72= Tff7b72False

Tff7b72tryTb4b4b4:

Tff7b72selfTff7b72.Td2a8ffprocessTff7b72.Td2a8ffkillTb4b4b4(Tb4b4b4)

Tff7b72except Tf85149Exception Tff7b72as Te6edf3eTb4b4b4:

Tff7b72pass

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffA pipe error occurred, the contained exception was: Ta5d6ff"Tff7b72+Tffa657strTb4b4b4(Te6edf3eTb4b4b4)Tb4b4b4, Te6edf3RNSTff7b72.Td2a8ffLOG_ERRORTb4b4b4)

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffThe interface Ta5d6ff"Tff7b72+Tffa657strTb4b4b4(Tff7b72selfTb4b4b4)Tff7b72+Ta5d6ff"Ta5d6ff experienced an unrecoverable error and is now offline.Ta5d6ff"Tb4b4b4, Te6edf3RNSTff7b72.Td2a8ffLOG_ERRORTb4b4b4)

Tff7b72if Te6edf3RNSTff7b72.Td2a8ffReticulumTff7b72.Td2a8ffpanic_on_interface_errorTb4b4b4:

Te6edf3RNSTff7b72.Td2a8ffpanicTb4b4b4(Tb4b4b4)

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffReticulum will attempt to reconnect the interface periodically.Ta5d6ff"Tb4b4b4, Te6edf3RNSTff7b72.Td2a8ffLOG_ERRORTb4b4b4)

Tff7b72selfTff7b72.Td2a8ffonline Tff7b72= Tff7b72False

Tff7b72selfTff7b72.Td2a8ffreconnect_pipeTb4b4b4(Tb4b4b4)

Tff7b72def Td2a8ffreconnect_pipeTb4b4b4(Tff7b72selfTb4b4b4)Tb4b4b4:

Tff7b72while Tff7b72not Tff7b72selfTff7b72.Td2a8ffonlineTb4b4b4:

Tff7b72tryTb4b4b4:

Te6edf3timeTff7b72.Td2a8ffsleepTb4b4b4(Tff7b72selfTff7b72.Td2a8ffrespawn_delayTb4b4b4)

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffAttempting to respawn subprocess for Ta5d6ff"Tff7b72+Tffa657strTb4b4b4(Tff7b72selfTb4b4b4)Tff7b72+Ta5d6ff"Ta5d6ff...Ta5d6ff"Tb4b4b4, Te6edf3RNSTff7b72.Td2a8ffLOG_VERBOSETb4b4b4)

Tff7b72selfTff7b72.Td2a8ffopen_pipeTb4b4b4(Tb4b4b4)

Tff7b72if Tff7b72selfTff7b72.Td2a8ffpipe_is_openTb4b4b4:

Tff7b72selfTff7b72.Td2a8ffconfigure_pipeTb4b4b4(Tb4b4b4)

Tff7b72except Tf85149Exception Tff7b72as Te6edf3eTb4b4b4:

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffError while spawning subprocess, the contained exception was: Ta5d6ff"Tff7b72+Tffa657strTb4b4b4(Te6edf3eTb4b4b4)Tb4b4b4, Te6edf3RNSTff7b72.Td2a8ffLOG_ERRORTb4b4b4)

Te6edf3RNSTff7b72.Td2a8fflogTb4b4b4(Ta5d6ff"Ta5d6ffReconnected pipe for Ta5d6ff"Tff7b72+Tffa657strTb4b4b4(Tff7b72selfTb4b4b4)Tb4b4b4)

Tff7b72def Tff7b72__str__Tb4b4b4(Tff7b72selfTb4b4b4)Tb4b4b4:

Tff7b72return Ta5d6ff"Ta5d6ffPipeInterface[Ta5d6ff"Tff7b72+Tff7b72selfTff7b72.Td2a8ffnameTff7b72+Ta5d6ff"Ta5d6ff]Ta5d6ff"